Transmisión en vivo con la API de Video de Vonage
La Video API de Vonage te permite crear casi cualquier experiencia de video que desees. Un caso de uso común que tienen los desarrolladores es la necesidad de situaciones en las que una o pocas personas transmiten a una audiencia más grande que solo escucha, como los asistentes que ven una transmisión en vivo de una conferencia.
En este tutorial
La Video API de Vonage te permite armar rápidamente una sala para permitir que una sola persona transmita y que otros se unan y miren. Repasaremos cómo poner en marcha una demostración con nuestras demostraciones existentes para que no tengas que escribir ningún código, pero también explicaremos qué hace el código en segundo plano.
- Ver la demostración - Echa un vistazo a la demo sin escribir código
- Cómo funciona la demostración - El lado del cliente - Qué hace el código del lado del cliente
- Cómo funciona la demostración - El lado del servidor - Qué hace el código del lado del servidor
Requisitos previos
Para completar el tutorial, necesitas:
- A Account de Vonage - para su clave y secreto API
Ver la demostración
Si quieres echar un vistazo a la demo antes de escribir ningún código, tenemos un servidor web de muestra y código JavaScript para probar cómo es una videollamada básica. Todo el código es de código abierto y está disponible públicamente, así que puedes probar la demo y luego usar el código para hacer tus propias modificaciones.
Iniciar el servidor Node.js
El vídeo de demostración requiere un servidor backend para manejar cosas como la creación de tokens de cliente para la autorización y la gestión general de la sesión. Mientras que usted puede construir esto en cualquier idioma que desee, tenemos un servidor pre-construido que puede utilizar para empezar en el Servidor de aprendizaje por vídeo de Vonage (Node.js) en Code Hub. Desde el Documentación para desarrolladores, haz clic en "Code Hub" en la barra de navegación superior y, a continuación, desplázate hacia abajo y busca la tarjeta de "Vonage Video Learning Server (Node.js)". Haz clic en ella para abrirla.
Obtendrás una descripción de lo que hace este proyecto. Por ahora, hagamos clic en "Obtener código" para que podamos cargarlo en el editor en línea Code Hub. Haz click en "Crear un nuevo entorno de desarrollo". Nombra el espacio de trabajo "Vonage Video Demo" ya que podemos usar este backend para múltiples demos. Esta demostración requiere que se le asigne un número, ya que el servidor de aprendizaje admite llamadas telefónicas a través de SIP. Aunque no lo utilizaremos en esta demostración, haz clic en "Asignar un número" para asignar un número existente de Vonage o compra uno nuevo para utilizarlo en demostraciones posteriores.
Code Hub creará una aplicación automáticamente para ti, incluyendo la configuración de las claves públicas y privadas que utilizará nuestra aplicación. Una vez creado el espacio de trabajo, entrarás en el editor de código, que es una versión en línea de Visual Studio Code. Siéntase libre de seguir a lo largo de las partes posteriores de esta demostración para ver el código, y puede editar este código según sea necesario para sus propios proyectos.
Para ejecutar la aplicación, haz clic en "Ver" en la parte superior del editor, y luego en "Terminal". Esto abrirá una línea de comandos en la que podemos ejecutar comandos. Todo lo que tenemos que hacer es escribir vcr deploy y se implementará el código. Esto tomará unos momentos, ya que empaqueta el código y lo ejecuta en los servidores de Vonage Code Hub. Deberemos tomar nota de la "dirección de host de instancia" que se muestra cerca del final.
Si todo funciona correctamente, debería poder visitar la "dirección del host de instancia" y aparecerá la siguiente página:
Probar el Front End
El servidor backend funciona directamente con todas nuestras demos preconstruidas, incluida esta demo individual. Vaya a https://github.com/Vonage-Community/video-api-web-samples/tree/main/Live-Broadcastque es el código fuente de la parte de front-end de esta demo. Esta muestra permite que dos usuarios con la URL se unan a la demo.
La forma más sencilla de ejecutar esta demo es hacer clic en el botón "Abrir en Stackblitz" del README.
Esto abrirá el proyecto en Stackblitz. Al igual que con el servidor backend, puede navegar por el código y modificarlo aquí si lo desea. Para este demo, todo lo que necesitamos hacer es abrir el proyecto js/config.js e introduzca la URL de la instancia de Code Hub en el archivo SAMPLE_SERVER_BASE_URL variable:
Una vez guardado el archivo, puede actualizar la vista de demostración en la parte derecha de Stackblitz. Esta muestra se divide en varias partes que incluyen una vista de host, y dos maneras diferentes de ver el vídeo en sí. Nos centraremos en la emisión sin RTMP.
Cómo funciona la demostración
Configurar una aplicación de Vonage
Para que nuestra aplicación de video funcione, necesitamos que nuestro cliente y servidor se comuniquen con los servidores de Vonage. Code Hub configura esto por nosotros, pero si estás ejecutando el código localmente o quieres saber qué implica una aplicación de video, se configura como cualquier otra API. Necesitamos configurar una aplicación de Vonage para alojar toda la configuración de nuestra aplicación, además de ayudarnos a generar los elementos necesarios para realizar la autenticación.
Diríjase a su Panel de control del cliente de Vonage e inicie sesión. Una vez iniciada la sesión:
- Haz clic en "Applications" en "Build".
- Haga clic en "Crear una nueva aplicación".
- Dale un nombre a la aplicación, como "Demostración de vídeo básica".
- Haga clic en "Generar clave pública y privada", lo que le hará descargar un archivo llamado
private.key. Guarde este archivo para más tarde. - Desplácese hacia abajo y active "Vídeo". Dejaremos estos valores vacíos por ahora.
- Haga clic en "Generar nueva aplicación" para crear la aplicación.
Una vez creada la aplicación, anote el ID de la aplicación. Si está ejecutando el código localmente, lo necesitaremos para configurar el backend. Si está utilizando Code Hub, el código del servidor ya tiene acceso al ID de la Aplicación y a la Clave Privada.
El lado del cliente
La parte cliente de la demostración consta de dos partes diferentes: algunos elementos HTML para colocar las fuentes de vídeo y, a continuación, JavaScript para obtener la información de inicio de sesión y comunicarse con los servidores de Vonage Video.
Dado que se trata de una demostración para navegador, utilizamos el SDK de JavaScript que se encuentra en https://unpkg.com/@vonage/client-sdk-video@latest/dist/js/opentok.jse incluirlo en una etiqueta script en nuestro HTML en index.html.
El anfitrión
Para la vista del anfitrión, en realidad sólo necesitamos ver la cámara del anfitrión, así como alguna interfaz de usuario para controlar diferentes opciones como iniciar la emisión, activar la baja latencia y las actualizaciones de estado. Para ver tu propia cámara, hacemos un <div> para alojar el elemento de vídeo:
El resto de la página Anfitrión son botones y configuración para la propia emisión en directo. Dejaremos todas las opciones, y nos preocuparemos de los controles de emisión. Estos son sólo algunos botones simples que vamos a cablear para llamar a la aplicación de servidor para iniciar y detener la transmisión de feeds.
Nuestra conexión en JavaScript es mínima en comparación con otras configuraciones en las que varias personas participarán juntas. Normalmente nos conectaríamos a la sesión y luego publicaríamos inmediatamente nuestros flujos de vídeo y audio, pero como estamos controlando cuándo se inicia y se detiene una emisión, lo haremos en dos etapas. En primer lugar, nos conectamos a la sesión de forma normal:
Una vez que nos hayamos conectado al flujo, añadiremos un receptor de eventos en el campo btn-start para que realmente publiquemos e iniciemos la emisión cuando el usuario pulse ese botón. El inicio (y la finalización) de la emisión se gestiona mediante los SDK del lado del servidor, por lo que realizamos una solicitud a nuestro servidor backend para iniciar la emisión.
En este punto, nuestro anfitrión está publicando a través de la transmisión misma, así como cualquier otra persona que se conecte. La demostración que tenemos admite invitados, por lo que a medida que se invita a los invitados a las reuniones, sus transmisiones se agregan automáticamente a la transmisión mediante la Video API de Vonage.
La aplicación del servidor se encarga de detener la emisión, por lo que una llamada rápida a esa ruta en nuestro servidor backend detendrá la emisión por sí misma. Adjuntamos un receptor de eventos a la ruta btn-stop para que se dispare al pulsarlo.
El espectador - Stream Broadcasting
Para un espectador, sólo necesitamos tener un lugar para mostrar el flujo de vídeo del anfitrión. Dado que los espectadores no publicarán sus propias secuencias, tendremos mucho menos código front-end para trabajar con ellos. Haremos un <div> para retener el flujo del Anfitrión.
Dado que un espectador nunca publica sus propios flujos, nuestro JavaScript simplemente se conecta al flujo y se limita a esperar a que la emisión cree flujos:
El espectador - HLS
Para ejecutar HLS sólo es necesario añadir un <video> en lugar de utilizar un elemento <div>. Si desea utilizar HLS en su lugar, hacemos un <video> al que adjuntaremos una fuente más adelante. Tenga en cuenta que necesitará JavaScript adicional para la mayoría de los navegadores, por lo que también incluiremos la biblioteca HLS JavaScript, disponible en NPM:
Nuestra demo hace que el usuario obtenga una URL del host que contendrá la URL de emisión como parámetro de consulta. Usaremos esto para adjuntar la transmisión al reproductor de vídeo. También haremos algunas comprobaciones básicas para asegurarnos de que HLS está soportado, ya que no todos los navegadores soportan HLS.
El lado del servidor
La parte del lado del servidor de cualquier aplicación de Vonage Video se utiliza para manejar la creación de sesiones, la generación de tokens de autenticación y tareas administrativas como iniciar y detener archivos. Para esta demostración, todo lo que nos preocupa es crear sesiones y tokens para que los usuarios puedan unirse a la sala. Si bien la API en sí es una API REST y se la puede llamar como se desee, te recomendamos que utilices la función SDK de Vonage Node que maneja toda la autenticación y las llamadas HTTP por ti. Puede instalarlo en su propia aplicación con:
El código de demostración ya lo tiene preinstalado. Si está ejecutando el código localmente, tendrá que ejecutar:
para descargar todas las dependencias y, a continuación, copie .envcopy a un nuevo archivo llamado .env. Deberá rellenar la información solicitada en .env como el ID de la aplicación, la ubicación de la clave privada en el disco y tu clave y secreto de API de Vonage.
El anfitrión
Le daremos al anfitrión un moderator de modo que cuando el front-end solicite las credenciales crearemos la sesión con el rol apropiado. Por lo demás, casi no hay diferencia entre la sesión de un anfitrión de retransmisiones en directo y la de un usuario de vídeo normal con el rol moderator papel.
Para obtener más información sobre la creación de fichas, consulte nuestra sección Caso práctico de vídeo individual que detalla cómo se pueden crear sesiones.
Cuando el usuario desea iniciar realmente la emisión, utilizamos el SDK de servidor para llamar a la función vonage.video.startBroadcast() que convertirá los flujos publicados en una sesión de difusión. A continuación, devolvemos esos datos al cliente para que disponga de toda la información necesaria para buscar la emisión y controlarla posteriormente.
La finalización de la emisión es prácticamente la misma: llamamos a la función del SDK del servidor vonage.video.stopBroadcast() para finalizar la emisión.
El espectador - Stream Broadcasting
En una situación de difusión, todo lo que tenemos que hacer es dar al espectador el tipo apropiado de token de conexión. Todo lo demás se maneja en el navegador por el código del lado del cliente.
El espectador - HLS
Los espectadores que ven a través de HLS no necesitan ninguna información de conexión especial, ya que todo se canaliza a través del reproductor de vídeo y la URL de emisión. Por lo tanto, no es necesario que el código del servidor genere ningún token. Si desea restringir la visualización de una emisión, deberá incorporarlo a su aplicación.
Conclusión
En este tutorial, viste lo que se incluye en el servidor backend para la transmisión basada en secuencias y en HLS, cómo crear un cliente web para que los usuarios vean las transmisiones, así como un vistazo a lo fácil que es usar Vonage Code Hub y Stack Blitz para probar muestras rápidamente.